]> dgit.raspbian.org Git - gnome-shell.git/commitdiff
doc: Use valid code in snippets
authorFlorian Müllner <fmuellner@gnome.org>
Thu, 25 Jan 2024 23:30:25 +0000 (00:30 +0100)
committerMarge Bot <marge-bot@gnome.org>
Sat, 27 Jan 2024 18:18:23 +0000 (18:18 +0000)
Some of the code examples use invalid code like `var` as variable
name or declarations in a single-statement context.

Fix those.

Part-of: <https://gitlab.gnome.org/GNOME/gnome-shell/-/merge_requests/3146>

HACKING.md

index 337bb94bb8ac39c9765282e98a34ef3591ff16f2..617f33be60dcbe96f3cb661dd965bba5b95b040b 100644 (file)
@@ -28,7 +28,7 @@ what to do.
         else
             bar = do_thing(b);
 
-        if (var === 5) {
+        if (bar === 5) {
             for (let i = 0; i < 10; i++)
                 print(i);
         } else {
@@ -103,12 +103,13 @@ under the imports:
 Always use either `const` or `let` when defining a variable.
 ```javascript
     // Iterating over an array
-    for (let i = 0; i < arr.length; ++i)
-        let item = arr[i];
+    for (let i = 0; i < arr.length; ++i) {
+        const item = arr[i];
+    }
 
     // Iterating over an object's properties
-    for (let prop in someobj) {
-        ...
+    for (const prop in someobj) {
+        const val = someobj[prop];
     }
 ```